GET https://api.d-tools.com/SI/SubscribePartialProjects/Projects?clients[0]={clients[0]}&clients[1]={clients[1]}&progresses[0]={progresses[0]}&progresses[1]={progresses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}&projectNumber={projectNumber}
Get partial projects published by a SI user .
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clients |
Clients to filter projects (Optional) |
Collection of string |
None. |
progresses |
Progresses to filter projects (Optional) |
Collection of string |
None. |
includeImported |
Boolean. Include already imported projects. Optional with default value false which means by default you will only see projects which are not imported. |
boolean |
Default value is False |
searchText |
The search text. |
string |
None. |
includeDeleted |
Boolean. Include project deleted in SI. Optional with default value false which means by default you will only see active projects which are not deleted. |
boolean |
Default value is False |
pageNumber |
The page number. |
integer |
Default value is 1 |
pageSize |
The page size. |
integer |
Default value is 50 |
projectNumber |
The project number. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
PartialProjectsResultName | Description | Type | Additional information |
---|---|---|---|
Projects |
Projects array |
Collection of PartialProjectInfo |
None. |
TotalCount |
Total count of projects |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Projects": [ { "MessageId": "sample string 1", "Id": "sample string 2", "IntegrationProjectId": "sample string 3", "ClientId": "sample string 4", "Client": "sample string 5", "ClientNumber": "sample string 6", "Name": "sample string 7", "Number": "sample string 8", "Progress": "sample string 9", "Approved": true, "CONumber": 1, "CurrencyCode": "sample string 11", "Price": 12.0, "ImportedOn": "2024-04-29T14:53:33.9858759+00:00", "PublishedOn": "2024-04-29T14:53:33.9858759+00:00", "Deleted": true, "Archived": true }, { "MessageId": "sample string 1", "Id": "sample string 2", "IntegrationProjectId": "sample string 3", "ClientId": "sample string 4", "Client": "sample string 5", "ClientNumber": "sample string 6", "Name": "sample string 7", "Number": "sample string 8", "Progress": "sample string 9", "Approved": true, "CONumber": 1, "CurrencyCode": "sample string 11", "Price": 12.0, "ImportedOn": "2024-04-29T14:53:33.9858759+00:00", "PublishedOn": "2024-04-29T14:53:33.9858759+00:00", "Deleted": true, "Archived": true } ], "TotalCount": 1 }
application/xml, text/xml
Sample:
<PartialProjectsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects"> <Projects> <PartialProjectInfo> <Approved>true</Approved> <Archived>true</Archived> <CONumber>1</CONumber> <Client>sample string 5</Client> <ClientId>sample string 4</ClientId> <ClientNumber>sample string 6</ClientNumber> <CurrencyCode>sample string 11</CurrencyCode> <Deleted>true</Deleted> <Id i:nil="true" /> <ImportedOn>2024-04-29T14:53:33.9858759+00:00</ImportedOn> <IntegrationProjectId>sample string 3</IntegrationProjectId> <Name>sample string 7</Name> <Number>sample string 8</Number> <Price>12</Price> <Progress>sample string 9</Progress> <PublishedOn>2024-04-29T14:53:33.9858759+00:00</PublishedOn> <Id>sample string 2</Id> <MessageId>sample string 1</MessageId> </PartialProjectInfo> <PartialProjectInfo> <Approved>true</Approved> <Archived>true</Archived> <CONumber>1</CONumber> <Client>sample string 5</Client> <ClientId>sample string 4</ClientId> <ClientNumber>sample string 6</ClientNumber> <CurrencyCode>sample string 11</CurrencyCode> <Deleted>true</Deleted> <Id i:nil="true" /> <ImportedOn>2024-04-29T14:53:33.9858759+00:00</ImportedOn> <IntegrationProjectId>sample string 3</IntegrationProjectId> <Name>sample string 7</Name> <Number>sample string 8</Number> <Price>12</Price> <Progress>sample string 9</Progress> <PublishedOn>2024-04-29T14:53:33.9858759+00:00</PublishedOn> <Id>sample string 2</Id> <MessageId>sample string 1</MessageId> </PartialProjectInfo> </Projects> <TotalCount>1</TotalCount> </PartialProjectsResult>